Add total to TasksResult
#412
Conversation
There was a problem hiding this comment.
Hello @Sherlouk
Thank you for your PR
Looks like the CI is failing, can you fix the test?
Test Case 'IndexesTests.testGetTasksWithParametersFromIndex' started at 2023-09-21 17:26:55.334
▿ Swift.DecodingError.keyNotFound
▿ keyNotFound: (2 elements)
- .0: CodingKeys(stringValue: "total", intValue: nil)
▿ .1: Swift.DecodingError.Context
- codingPath: 0 elements
- debugDescription: "No value associated with key CodingKeys(stringValue: \"total\", intValue: nil) (\"total\")."
- underlyingError: nil
Here is the CI so that you can see the full logs: https://github.com/meilisearch/meilisearch-swift/actions/runs/6213141814/job/17012982161?pr=412
|
Weird, let me take a look into that. It might be a version incompatibility issue, or an edge case where total isn't returned (spec says it's now required). I'll look into it. |
|
Well I'm glad that it turned out that I was just being a bit silly and only ran the integration tests, as they're separate within Xcode! The unit tests have embedded JSON, not relying on the running of a local Meili instance. I've updated, and run all tests this time, and am confident I've patched that now. I've also familiarised myself with the GitHub Actions workflows so am more confident in what that does. |
Sherlouk
force-pushed
the
402-total-tasks
branch
2 times, most recently
from
f73ce76 to
2067d70
Compare
Sherlouk
force-pushed
the
402-total-tasks
branch
from
2067d70 to
195e2bf
Compare
|
Can see here that I was running into some random errors trying to download MeiliSearch itself - retrying resolved it (but explains the empty force commits). |
|
I'm going to close this PR as once #417 is merged I have a PR which covers the rest of task parity (and for the sake of 7 lines of code makes sense to include there). |
425: [BREAKING] Tasks Parity r=curquiza a=Sherlouk Closes #363 Closes #366 Closes #368 Closes #254 ## User/Client Facing * Introduces Cancel Tasks API * Introduces Delete Tasks API * Provides compiler-safe access to task types * Utilising a future-proof solution avoiding errors should new task types be added without Swift support * Provides compiler-safe access to task result details * Utilising a future-proof solution avoiding errors should new details be added without Swift support * Grouped task related models into own directory * Uses `Date` objects instead of `String` for dates within task models * Added missing fields to existing task models * Fixed error caused by global tasks * Uses compiler-safe types in task query to improve safety * Adds `total` to task results response (replacing #412) * Removed all instances of `try!` (force try) to prevent crashes in test runner ## Breaking Changes⚠️ This is a breaking change. Even with something as simple as moving to a enum for TaskType requires changes to clients. This PR looks to bring all task changes together meaning that clients can upgrade to this new and safe API design in one go. * `Task.Status` has a new value `.canceled` (handle in any `switch` cases) * `TaskType` replaces a previous String based API (use `.description` to access String) * `TasksQuery` uses compiled types instead of String APIs (example: `"indexUpdate"` is now `.indexUpdate`) * `enqueuedAt` now uses Date instead of ISO-8601 String ## Parity Reviewing documentation available on MeiliSearch's website, this PR brings the `Tasks` API up to **100% parity** with existing features. It resolves many errors caused by the previous design (both architecturally but also instability in the current release), and provides future-proofness against further scope within the tasks API. ## Personal As I am developing my own Swift based application for monitoring MeiliSearch (and it's tasks), this branch has been extremely helpful for me in exploring jobs and being able to cancel them and performing my own housekeeping. The type safety has been delightful and actually detected a bug in my original implementation which had a typo in a task name. Co-authored-by: James Sherlock <15193942+Sherlouk@users.noreply.github.com>
Pull Request
Related issue
Fixes #402
What does this PR do?
totalattribute to GET tasks request. This is a recent addition, and so it may be desired to make this optional for backwards compatibility.PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!